Skip to content

[SDK] Fix: Add JSDoc documentation for getSocialIcon function #5395

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Nov 12, 2024
Merged

[SDK] Fix: Add JSDoc documentation for getSocialIcon function #5395

merged 1 commit into from
Nov 12, 2024
+11 −2

Conversation

@gregfromstl
Copy link
Contributor

@gregfromstl gregfromstl commented Nov 12, 2024 •
edited by pr-codex bot
Loading

CNCT-2324

PR-Codex overview

This PR focuses on enhancing the documentation for the getSocialIcon function in the walletIcon.ts file, providing a clear description of its purpose, parameters, return value, and usage examples.

Detailed summary

  • Added a JSDoc comment for the getSocialIcon function.
  • Described the function's purpose, parameters, return value, and included usage examples.
  • Specified that the function returns a data URI for the SVG icon or a generic wallet icon.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

@gregfromstl gregfromstl added the Bug Something isn't working as intended in a provided reproduction. label Nov 12, 2024
@gregfromstl gregfromstl self-assigned this Nov 12, 2024
@linear
Copy link

linear bot commented Nov 12, 2024

CNCT-2324 Fix `getSocialIcon` docs

@changeset-bot
Copy link

changeset-bot bot commented Nov 12, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: a1707f6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Nov 12, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 12, 2024 8:28pm
thirdweb_playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 12, 2024 8:28pm
thirdweb-www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 12, 2024 8:28pm
wallet-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 12, 2024 8:28pm

@github-actions
Copy link
Contributor

github-actions bot commented Nov 12, 2024 •
edited
Loading

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 44.15 KB (0%) 883 ms (0%) 203 ms (-35.1% 🔽) 1.1 s
thirdweb (cjs) 104.69 KB (0%) 2.1 s (0%) 643 ms (-5.44% 🔽) 2.8 s
thirdweb (minimal + tree-shaking) 5.72 KB (0%) 115 ms (0%) 22 ms (+81.35% 🔺) 136 ms
thirdweb/chains (tree-shaking) 506 B (0%) 10 ms (0%) 6 ms (+24.28% 🔺) 16 ms
thirdweb/react (minimal + tree-shaking) 18.78 KB (0%) 376 ms (0%) 88 ms (+41.12% 🔺) 463 ms

@codecov
Copy link

codecov bot commented Nov 12, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 45.33%. Comparing base (f31801e) to head (a1707f6).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #5395   +/-   ##
=======================================
  Coverage   45.33%   45.33%           
=======================================
  Files        1067     1067           
  Lines       55405    55405           
  Branches     4015     4001   -14     
=======================================
  Hits        25116    25116           
  Misses      29602    29602           
  Partials      687      687
Flag Coverage Δ *Carryforward flag
legacy_packages 65.68% <ø> (ø) Carriedforward from f31801e
packages 40.35% <100.00%> (ø)

*This pull request uses carry forward flags. Click here to find out more.

Files with missing lines Coverage Δ
...ckages/thirdweb/src/react/core/utils/walletIcon.ts 57.83% <100.00%> (ø)

@gregfromstl gregfromstl force-pushed the greg/cnct-2324-fix-getsocialicon-docs branch from 6b4864b to cd9f7bd Compare November 12, 2024 19:56
@gregfromstl gregfromstl added the merge-queue Adds the pull request to Graphite's merge queue. label Nov 12, 2024
@gregfromstl Graphite App
Copy link
Contributor Author

gregfromstl commented Nov 12, 2024 •
edited by graphite-app bot
Loading

Merge activity

  • Nov 12, 2:56 PM EST: The merge label 'merge-queue' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
  • Nov 12, 3:13 PM EST: A user added this pull request to the Graphite merge queue.
  • Nov 12, 3:29 PM EST: A user merged this pull request with the Graphite merge queue.

@gregfromstl
[SDK] Fix: Add JSDoc documentation for getSocialIcon function (#5395)
a1707f6 
CNCT-2324

<!-- start pr-codex -->

---

## PR-Codex overview
This PR enhances the documentation for the `getSocialIcon` function, providing a detailed JSDoc comment that explains its purpose, parameters, return value, and includes usage examples.

### Detailed summary
- Added a JSDoc comment for the `getSocialIcon` function.
- Described the function's purpose, parameters, return value, and provided usage examples.
- Changed the return type of `getSocialIcon` to explicitly specify it returns a `string`.

> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`

<!-- end pr-codex -->
@gregfromstl gregfromstl force-pushed the greg/cnct-2324-fix-getsocialicon-docs branch from cd9f7bd to a1707f6 Compare November 12, 2024 20:13
@graphite-app graphite-app bot merged commit a1707f6 into main Nov 12, 2024
32 checks passed
@graphite-app graphite-app bot deleted the greg/cnct-2324-fix-getsocialicon-docs branch November 12, 2024 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jnsdls jnsdls jnsdls approved these changes

@joaquim-verges joaquim-verges Awaiting requested review from joaquim-verges

@MananTank MananTank Awaiting requested review from MananTank

@edwardysun edwardysun Awaiting requested review from edwardysun

Assignees

@gregfromstl gregfromstl

Labels

Bug Something isn't working as intended in a provided reproduction. merge-queue Adds the pull request to Graphite's merge queue. packages

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@gregfromstl @jnsdls